SGI Freeware 1999 August

home *** CD-ROM | disk | FTP | other *** search

/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_qt.idb / usr / freeware / catman / p_man / cat3 / qarray.Z / qarray

Wrap

Text File | 1998-10-28 | 25.6 KB | 529 lines

QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888)))) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) NNNNAAAAMMMMEEEE QArray - Template class that provides arrays of simple types SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS #include <qarray.h> Inherits QGArray. Inherited by QByteArray and QPointArray. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrrssss QQQQAAAArrrrrrrraaaayyyy (((()))) QQQQAAAArrrrrrrraaaayyyy (((( iiiinnnntttt ssssiiiizzzzeeee )))) QQQQAAAArrrrrrrraaaayyyy (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) ~~~~QQQQAAAArrrrrrrraaaayyyy () QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>>&&&& ooooppppeeeerrrraaaattttoooorrrr==== (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) ttttyyyyppppeeee**** ddddaaaattttaaaa (((()))) ccccoooonnnnsssstttt uuuuiiiinnnntttt nnnnrrrreeeeffffssss (((()))) ccccoooonnnnsssstttt uuuuiiiinnnntttt ssssiiiizzzzeeee (((()))) ccccoooonnnnsssstttt bbbboooooooollll iiiissssEEEEmmmmppppttttyyyy (((()))) ccccoooonnnnsssstttt bbbboooooooollll iiiissssNNNNuuuullllllll (((()))) ccccoooonnnnsssstttt bbbboooooooollll rrrreeeessssiiiizzzzeeee (((( uuuuiiiinnnntttt ssssiiiizzzzeeee )))) bbbboooooooollll ttttrrrruuuunnnnccccaaaatttteeee (((( uuuuiiiinnnntttt ppppoooossss )))) bbbboooooooollll ffffiiiillllllll (((( ccccoooonnnnsssstttt ttttyyyyppppeeee &&&& _v,,,, iiiinnnntttt ssssiiiizzzzeeee====----1111====----1111 )))) vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd ddddeeeettttaaaacccchhhh (((()))) QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> ccccooooppppyyyy (((()))) ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>>&&&& aaaassssssssiiiiggggnnnn (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>>&&&& aaaassssssssiiiiggggnnnn (((( ccccoooonnnnsssstttt ttttyyyyppppeeee **** _d_a_t_a,,,, uuuuiiiinnnntttt ssssiiiizzzzeeee )))) QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>>&&&& dddduuuupppplllliiiiccccaaaatttteeee (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>>&&&& dddduuuupppplllliiiiccccaaaatttteeee (((( ccccoooonnnnsssstttt ttttyyyyppppeeee **** _d_a_t_a,,,, uuuuiiiinnnntttt ssssiiiizzzzeeee )))) QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>>&&&& sssseeeettttRRRRaaaawwwwDDDDaaaattttaaaa (((( ccccoooonnnnsssstttt ttttyyyyppppeeee **** _d_a_t_a,,,, uuuuiiiinnnntttt ssssiiiizzzzeeee )))) vvvvooooiiiidddd rrrreeeesssseeeettttRRRRaaaawwwwDDDDaaaattttaaaa (((( ccccoooonnnnsssstttt ttttyyyyppppeeee **** _d_a_t_a,,,, uuuuiiiinnnntttt ssssiiiizzzzeeee )))) iiiinnnntttt ffffiiiinnnndddd (((( ccccoooonnnnsssstttt ttttyyyyppppeeee &&&& _v,,,, uuuuiiiinnnntttt _i_n_d_e_x====0000 )))) ccccoooonnnnsssstttt iiiinnnntttt ccccoooonnnnttttaaaaiiiinnnnssss (((( ccccoooonnnnsssstttt ttttyyyyppppeeee &&&& vvvv )))) ccccoooonnnnsssstttt ttttyyyyppppeeee&&&& ooooppppeeeerrrraaaattttoooorrrr[[[[]]]] (((( iiiinnnntttt iiiinnnnddddeeeexxxx )))) ccccoooonnnnsssstttt ttttyyyyppppeeee&&&& aaaatttt (((( uuuuiiiinnnntttt iiiinnnnddddeeeexxxx )))) ccccoooonnnnsssstttt ooooppppeeeerrrraaaattttoooorrrr ccccoooonnnnsssstttt ttttyyyyppppeeee**** ()const bbbboooooooollll ooooppppeeeerrrraaaattttoooorrrr======== (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) ccccoooonnnnsssstttt bbbboooooooollll ooooppppeeeerrrraaaattttoooorrrr!!!!==== (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) ccccoooonnnnsssstttt PPPPrrrrooootttteeeecccctttteeeedddd MMMMeeeemmmmbbbbeeeerrrrssss QQQQAAAArrrrrrrraaaayyyy (((( iiiinnnntttt,,,, iiiinnnntttt )))) DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN The QArray class is a template class that provides arrays of simple types. QArray is implemented as both a template and a macro class. Define a template instance QArray<X> to create an array that contains X items. The QVector collection class is also a kind of array. Like Page 1 (printed 9/22/98) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888)))) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) all collection classes, it has pointers to the contained items. QArray stores the array elements directly in the array. It can only deal with simple types, i.e. C++ types, structs and classes that have no constructors, destructors or virtual functions. QArray uses bitwise operations to copy and compare array elements. QArray uses explicit sharing with a reference count. If more than one array share common data, and one array is modified, all arrays will be modified. The benefit of sharing is that a program does not need to duplicate data when it is not required, which results in less memory usage and less copying of data. Example: #include <qarray.h> #include <stdio.h> QArray<int> fib( int num ) // returns fibonacci array { ASSERT( num > 2 ); QArray<int> f( num ); // array of ints f[0] = f[1] = 1; // initialize first two numbers for ( int i=2; i<num; i++ ) f[i] = f[i-1] + f[i-2]; return f; } void main() { QArray<int> a = fib( 6 ); // get 6 first fibonaccis int i; for ( i=0; i<a.size(); i++ ) // print them prinf( "%d: %d\n", i, a[i] ); printf( "1 is found %d time(s)\n", a.contains(1) ); printf( "5 is found at index %d\n", a.find(5) ); } Program output: 0: 1 1: 1 2: 2 3: 3 4: 5 5: 8 1 is found 2 times 5 is found at index 4 An array can also be instantiated through a macro expansion, Page 2 (printed 9/22/98) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888)))) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) but this is necessary only for compilers that do not support templates. We recommend using templates if your compiler supports it. Macros are much harder to debug. Macro expansion: ... Q_DECLARE(QArrayM,X); // declares the array void main() { QArrayM(X) a; // array of X elements ... If you want to make your code work for compilers that do not have template support, but use templates if they are available, you can use typedef: ... #if defined(USE_TEMPLATECLASS) // defined in qglobal.h typedef QArrayT<X> XArray; #else typedef Q_DECLARE(QArrayM,X) XArray; #endif void main() { XArray a; // array of X elements ... QArrayT refers to the QArray template and QArrayM refers to the QArray macro. QArray defaults to QArrayT if templates are supported, QArrayM otherwise. See also: Shared Classes MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDOOOOCCCCUUUUMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN QQQQAAAArrrrrrrraaaayyyy::::::::QQQQAAAArrrrrrrraaaayyyy (((()))) Constructs a null array. See also: isNull(). QQQQAAAArrrrrrrraaaayyyy::::::::QQQQAAAArrrrrrrraaaayyyy (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) Constructs a shallow copy of _a. See also: assign(). QQQQAAAArrrrrrrraaaayyyy::::::::QQQQAAAArrrrrrrraaaayyyy (((( iiiinnnntttt ssssiiiizzzzeeee )))) Constructs an array with room for _s_i_z_e elements. Makes a null array if _s_i_z_e == 0. Note that the elements are not initialized. See also: resize() and isNull(). Page 3 (printed 9/22/98) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888)))) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) QQQQAAAArrrrrrrraaaayyyy::::::::QQQQAAAArrrrrrrraaaayyyy (((( iiiinnnntttt,,,, iiiinnnntttt )))) [[[[pppprrrrooootttteeeecccctttteeeedddd]]]] Constructs an array _w_i_t_h_o_u_t _a_l_l_o_c_a_t_i_n_g array space. The arguments should be (0, 0). Use at own risk. QQQQAAAArrrrrrrraaaayyyy::::::::~~~~QQQQAAAArrrrrrrraaaayyyy (((()))) Dereferences the array data and deletes it if this was the last reference. QQQQAAAArrrrrrrraaaayyyy::::::::ooooppppeeeerrrraaaattttoooorrrr ccccoooonnnnsssstttt ttttyyyyppppeeee **** (((()))) ccccoooonnnnsssstttt Cast operator. Returns a pointer to the array. See also: data(). QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& QQQQAAAArrrrrrrraaaayyyy::::::::aaaassssssssiiiiggggnnnn (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) Shallow copy. Dereferences the current array and references the data contained in _a instead. Returns a reference to this array. See also: operator=(). QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& QQQQAAAArrrrrrrraaaayyyy::::::::aaaassssssssiiiiggggnnnn (((( ccccoooonnnnsssstttt ttttyyyyppppeeee **** ddddaaaattttaaaa,,,, uuuuiiiinnnntttt ssssiiiizzzzeeee )))) Shallow copy. Dereferences the current array and references the array data _d_a_t_a, which contains _s_i_z_e elements. Returns a reference to this array. Do not delete _d_a_t_a later, QArray takes care of that. ttttyyyyppppeeee &&&& QQQQAAAArrrrrrrraaaayyyy::::::::aaaatttt (((( uuuuiiiinnnntttt iiiinnnnddddeeeexxxx )))) ccccoooonnnnsssstttt Returns a reference to the element at position _i_n_d_e_x in the array. This can be used to both read and set an element. See also: operator[](). iiiinnnntttt QQQQAAAArrrrrrrraaaayyyy::::::::ccccoooonnnnttttaaaaiiiinnnnssss (((( ccccoooonnnnsssstttt ttttyyyyppppeeee &&&& vvvv )))) ccccoooonnnnsssstttt Returns the number of times _v occurs in the array. See also: find(). QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> QQQQAAAArrrrrrrraaaayyyy::::::::ccccooooppppyyyy (((()))) ccccoooonnnnsssstttt Returns a deep copy of this array. See also: detach() and duplicate(). ttttyyyyppppeeee **** QQQQAAAArrrrrrrraaaayyyy::::::::ddddaaaattttaaaa (((()))) ccccoooonnnnsssstttt Returns a pointer to the actual array data. The array is a null array if data() == 0 (null pointer). See also: isNull(). Page 4 (printed 9/22/98) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888)))) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) vvvvooooiiiidddd QQQQAAAArrrrrrrraaaayyyy::::::::ddddeeeettttaaaacccchhhh (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]] Detaches this array from shared array data, i.e. makes a private, deep copy of the data. Copying will only be performed if the reference count is greater than one. See also: copy(). Reimplemented from QGArray. QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& QQQQAAAArrrrrrrraaaayyyy::::::::dddduuuupppplllliiiiccccaaaatttteeee (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) Deep copy. Dereferences the current array and obtains a copy of the data contained in _a instead. Returns a reference to this array. See also: copy(). QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& QQQQAAAArrrrrrrraaaayyyy::::::::dddduuuupppplllliiiiccccaaaatttteeee (((( ccccoooonnnnsssstttt ttttyyyyppppeeee **** ddddaaaattttaaaa,,,, uuuuiiiinnnntttt ssssiiiizzzzeeee )))) Deep copy. Dereferences the current array and obtains a copy of the array data _d_a_t_a instead. Returns a reference to this array. See also: copy(). bbbboooooooollll QQQQAAAArrrrrrrraaaayyyy::::::::ffffiiiillllllll (((( ccccoooonnnnsssstttt ttttyyyyppppeeee &&&& vvvv,,,, iiiinnnntttt ssssiiiizzzzeeee====----1111====----1111 )))) Fills the array with the value _v. If _s_i_z_e is specified as different from -1, then the array will be resized before filled. Returns TRUE if successful, or FALSE if the memory cannot be allocated (only when _s_i_z_e != -1). See also: resize(). iiiinnnntttt QQQQAAAArrrrrrrraaaayyyy::::::::ffffiiiinnnndddd (((( ccccoooonnnnsssstttt ttttyyyyppppeeee &&&& vvvv,,,, uuuuiiiinnnntttt iiiinnnnddddeeeexxxx====0000 )))) ccccoooonnnnsssstttt Finds the first occurrence of _v, starting at position _i_n_d_e_x. Returns the position of _v, or -1 if _v could not be found. See also: contains(). bbbboooooooollll QQQQAAAArrrrrrrraaaayyyy::::::::iiiissssEEEEmmmmppppttttyyyy (((()))) ccccoooonnnnsssstttt Returns TRUE if the array is empty, i.e. size() == 0, otherwise FALSE. isEmpty() is equivalent with isNull() for QArray. Note that this is not the case for QString::isEmpty(). bbbboooooooollll QQQQAAAArrrrrrrraaaayyyy::::::::iiiissssNNNNuuuullllllll (((()))) ccccoooonnnnsssstttt Returns TRUE if the array is null, otherwise FALSE. Page 5 (printed 9/22/98) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888)))) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) A null array has size() == 0 and data() == 0. uuuuiiiinnnntttt QQQQAAAArrrrrrrraaaayyyy::::::::nnnnrrrreeeeffffssss (((()))) ccccoooonnnnsssstttt Returns the reference count for the shared array data. This reference count is always greater than zero. bbbboooooooollll QQQQAAAArrrrrrrraaaayyyy::::::::ooooppppeeeerrrraaaattttoooorrrr!!!!==== (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) ccccoooonnnnsssstttt Returns TRUE if this array is different from _a, otherwise FALSE. The two arrays are bitwise compared. See also: operator==(). QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& QQQQAAAArrrrrrrraaaayyyy::::::::ooooppppeeeerrrraaaattttoooorrrr==== (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) Assigns a shallow copy of _a to this array and returns a reference to this array. Equivalent to assign( a ). bbbboooooooollll QQQQAAAArrrrrrrraaaayyyy::::::::ooooppppeeeerrrraaaattttoooorrrr======== (((( ccccoooonnnnsssstttt QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& aaaa )))) ccccoooonnnnsssstttt Returns TRUE if this array is equal to _a, otherwise FALSE. The two arrays are bitwise compared. See also: operator!=(). ttttyyyyppppeeee &&&& QQQQAAAArrrrrrrraaaayyyy::::::::ooooppppeeeerrrraaaattttoooorrrr[[[[]]]] (((( iiiinnnntttt iiiinnnnddddeeeexxxx )))) ccccoooonnnnsssstttt Returns a reference to the element at position _i_n_d_e_x in the array. This can be used to both read and set an element. Equivalent to at(). See also: at(). vvvvooooiiiidddd QQQQAAAArrrrrrrraaaayyyy::::::::rrrreeeesssseeeettttRRRRaaaawwwwDDDDaaaattttaaaa (((( ccccoooonnnnsssstttt ttttyyyyppppeeee **** ddddaaaattttaaaa,,,, uuuuiiiinnnntttt ssssiiiizzzzeeee )))) Resets raw data that was set using setRawData(). The arguments must be the data and length that were passed to setRawData(). This is for consistency checking. See also: setRawData(). bbbboooooooollll QQQQAAAArrrrrrrraaaayyyy::::::::rrrreeeessssiiiizzzzeeee (((( uuuuiiiinnnntttt ssssiiiizzzzeeee )))) Resizes (expands or shrinks) the array to _s_i_z_e elements. The array becomes a null array if _s_i_z_e == 0. Returns TRUE if successful, or FALSE if the memory cannot be allocated. New elements will not be initialized. Page 6 (printed 9/22/98) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888)))) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) See also: size(). QQQQAAAArrrrrrrraaaayyyy<<<<ttttyyyyppppeeee>>>> &&&& QQQQAAAArrrrrrrraaaayyyy::::::::sssseeeettttRRRRaaaawwwwDDDDaaaattttaaaa (((( ccccoooonnnnsssstttt ttttyyyyppppeeee **** ddddaaaattttaaaa,,,, uuuuiiiinnnntttt ssssiiiizzzzeeee )))) Sets raw data and returns a reference to the array. Dereferences the current array and sets the new array data to _d_a_t_a and the new array size to _s_i_z_e. Do not attempt to resize or re-assign the array data when raw data has been set. Call resetRawData(d,len) to reset the array. Setting raw data is useful because it sets QArray data without allocating memory or copying data. Example I (intended use): static char bindata[] = { 231, 1, 44, ... }; QByteArray a; a.setRawData( bindata, sizeof(bindata) ); // a points to bindata QDataStream s( a, IO_ReadOnly ); // open on a's data s >> <something>; // read raw bindata a.resetRawData( bindata, sizeof(bindata) ); // finished Example II (you don't want to do this): static char bindata[] = { 231, 1, 44, ... }; QByteArray a, b; a.setRawData( bindata, sizeof(bindata) ); // a points to bindata a.resize( 8 ); // will crash b = a; // will crash a[2] = 123; // might crash // forget to resetRawData - will crash WWWWaaaarrrrnnnniiiinnnngggg:::: If you do not call resetRawData(), QArray will attempt to deallocate or reallocate the raw data, which might not be too good. Be careful. See also: resetRawData(). uuuuiiiinnnntttt QQQQAAAArrrrrrrraaaayyyy::::::::ssssiiiizzzzeeee (((()))) ccccoooonnnnsssstttt Returns the size of the array (max number of elements). The array is a null array if size() == 0. See also: isNull() and resize(). Examples: drawdemo/drawdemo.cpp bbbboooooooollll QQQQAAAArrrrrrrraaaayyyy::::::::ttttrrrruuuunnnnccccaaaatttteeee (((( uuuuiiiinnnntttt ppppoooossss )))) Truncates the array at position _p_o_s. Returns TRUE if successful, or FALSE if the memory cannot be Page 7 (printed 9/22/98) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888)))) QQQQAAAArrrrrrrraaaayyyy((((3333qqqqtttt)))) allocated. Equivalent to resize(_p_o_s). See also: resize(). SSSSEEEEEEEE AAAALLLLSSSSOOOO hhhhttttttttpppp::::////////wwwwwwwwwwww....ttttrrrroooollllllll....nnnnoooo////qqqqtttt////qqqqaaaarrrrrrrraaaayyyy....hhhhttttmmmmllll CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT Copyright 1992-1997 Troll Tech AS. See the LICENSE file included in the distribution for a complete license statement. AAAAUUUUTTTTHHHHOOOORRRR Generated automatically from the source code. Page 8 (printed 9/22/98)